Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / detct31c.arc / LOG.DOC < prev next >

Wrap

Text File | 1990-03-10 | 40KB | 1,388 lines

THE DETECTIVE LOG Version 3.1 A Historical Manager For THE DETECTIVE for the IBM Personal Computers and Other Compatibles --------- User's Manual (c) 1990 PC SOFT-TECH March 5, 1990 Table of Contents Introduction................................................1 Installation................................................2 Main menu...................................................3 Selecting a base file.......................................4 Applying THE DETECTIVE run to history.......................5 Deleting old records........................................6 Re-Indexing the databases...................................7 Browse and search files.....................................8 Graphically displaying disk space..........................10 Print files and comments...................................11 Maintain and browse file comments..........................12 Miscellaneous..............................................14 APPENDICES: ----------- System Requirements, Limits, and Performance...............A Warranty/Disclaimer/Terms & Conditions.....................B Registration...............................................C PAGE 1 -- INTRODUCTION -- THE DETECTIVE LOG is a series of programs which allows the user to keep a history of all file modifications made on all drives and directories of their system. This product is a supplement to THE DETECTIVE and uses the output from THE DETECTIVE to build a history file containing all file additions, deletions and changes. The user has the option of making comments for any file contained in the history, printing and browsing the history and comments based on wide range of selection criteria, and graphically displaying disk space used by the files in history (provided a graphics card is installed). THE DETECTIVE LOG requires that a base file, [ctrlfile].NEW, from THE DETECTIVE exists in the current directory. Without this file the LOG cannot run. The base file (refer to THE DETECTIVE docu- mentation manual) contains a snapshot of all selected files in all selected drives and directories. This base file is the basis upon which all LOG features are built. THE DETECTIVE LOG is available in two formats. The first is as share-ware from many public bulletin board systems. The second is through registration (see Appendix D for order form). Registered versions of THE DETECTIVE LOG are available on 3 1/2" and 5 1/4" diskettes. NOTE: THE FREE VERSION OF THE DETECTIVE LOG WILL NOT PROCESS THE ROOT DIRECTORIES OF ANY DISK DRIVE. IF YOU HAVE DONE A GOOD JOB OF DISK MANAGEMENT, THE ROOT DIRECTORY SHOULD CONTAIN 3 PROGRAMS ONLY (COMMAND.COM, IBMBIO.COM, AND IBMDOS.COM). WE REALIZE THAT THESE ARE THE MOST IMPORTANT PROGRAMS IN YOUR SYSTEM, BUT WE BELIEVE THAT QUALITY SOFTWARE IS WORTH A PRICE. If you fear that the copy of THE DETECTIVE you have received has been tampered or simply want to get the latest version, you can call our bulletin board system at (414) 241-9125. The BBS operates at 9600,N,8,1. You may also place your order through the BBS (PO number required, original PO received before shipment will be made) or send us some mail with any questions or comments you may have. PAGE 2 -- INSTALLATION -- THE DETECTIVE LOG should be installed into the same directory as THE DETECTIVE. The log will only search the current directory for the base file(s) created by THE DETECTIVE. All files created by the log will be built in this directory. To install THE DETECTIVE LOG on the hard drive of your PC, you must first move to the directory containing THE DETECTIVE. Then follow the instructions provided on the readme.1st file on the disk (first disk if two low density disks were received). These instructions explain how to self-extract THE DETECTIVE LOG programs from the two .EXE files provided (LOGPART1.EXE and LOGPART2.EXE). These instructions are as follows: 1. MAKE A DIRECTORY TO HOLD THE PROGRAMS ('MD DETECT' FOR EXAMPLE). 2. MOVE INTO THE NEWLY CREATED DIRECTORY ('CD DETECT'). 3. PLACE THE FIRST DISKETTE IN FLOPPY DRIVE 'A' AND TYPE 'A:LOGPART1'. IF YOU PUT THE DISKETTE IN DRIVE 'B', TYPE 'B:LOGPART1'. 4. PLACE THE SECOND DISKETTE IN THE PROPER FLOPPY DRIVE AND TYPE 'A:LOGPART2' OR 'B:LOGPART2' ACCORDINGLY. 5. YOU ARE NOW READY TO GO. THE DETECTIVE LOG is now ready for use. If you wish to print a copy of THE DETECTIVE LOG manual simply type "COPY LOG.DOC PRN" while in the DETECT directory. The directory DETECT is not required, simply suggested. You can use any directory name, in any path, on any drive. PAGE 3 -- MAIN MENU -- The main menu is invoked by typing DLMENU and pressing the enter key. The menus first task is to search the current directory for the first [ctrlfile].NEW file and verify that the .NEW file is not corrupted. The [ctrlfile].NEW file is a base file that was created from THE DETECTIVE. Once the base file is verified, it sets this name for use on all subsequent processing. For example, if the first base file found is MYSYS.NEW, all browsing, printing, graphing, and loading will be based on MYSYS.NEW. Also all files created by the log will use the same filename, in this case MYSYS.*. After the base file verified a window opens showing all options available. You can use the up and down arrow keys to position the highlight bar over the option you wish to use and then press enter to execute that option. You can also press the first letter of the option you wish to perform rather than moving the highlight bar. Options available from the main menu are: Select Base File Name Apply Detective Run to History Delete Old Records Re-Index Databases Browse/Search Files Graphically Display Disk Space Print Files and Comments Maintain and Browse File Comments Exit the Log Program Detailed information and help for each of these options is available by highlighting the option and pressing the [F1] key. The last line of the screen, as is the case on all screens in the log, shows any special function keys available. F1 is always available for context sensitive help. ESC is generally available which exits the current function. PAGE 4 -- SELECTING A BASE FILE -- This option is only available if the menu determines that multiple base files exist. Selecting this option will open a window that contains all [ctrlfile].NEW files in the current directory. You then move the highlight bar up or down with the arrow keys until the base file you want is highlighted. You then press enter to select this as your new base file. If you change your mind, press ESC to exit this function without changing the current base file. The current base file to be used by THE DETECTIVE appears at the bottom of the main menu. Remember, as pointed out in THE DETECTIVE users manual, multiple [ctrlfile].NEW files are allowed to give the user flexibility in which files to track or verify CRC's for virus detection. As an example the user may wish to check all files on his/her system once a month, but check a certain heavily used drive once a week. This may be accomplished by setting up two distinct [ctrlfile].NEW files in THE DETECTIVE. PAGE 5 -- APPLYING THE DETECTIVE RUN TO HISTORY -- This option loads the current base file into history. You should select this option after every run of THE DETECTIVE in order to keep your history up to date. The program will first ensure that the history files exist. If they don't, you will have to reply (y)es or (n)o depending whether you want them built or not. If the history files already exist the date and time stamps of the current base file are compared against the last one applied to history. The program will not let you apply a base file that is older than the last one applied, and will prompt you if the date and time stamps are the same as the last one applied. Generally you will not have a problem unless you abort the load process. If, for some reason, you need to re-apply the same base file to history, problems should not occur. It is always safest to have a backup copy of the history files in case some problems exist. The program compares the current base files list of files, directories, and drives to the record contained in history. Any changes (additions, changes or deletions) cause a record to be added to history reflecting this difference. This results in a history file containing a log of all file modifications. During this process, the total disk space used by the files in the base file is also stored in separate history file. In order to optimize database access, you must choose the size of the path name to be allocated in the databases. DOS has a limit of 64 characters for path names while Novell Netware supports one of 128 characters. Using a path name of 128 characters will handle all future possibilities, but will use significantly more disk space as well as processing time. On the other hand, a path size that is large enough for the current maximum path will surely be too small in the near future. Picking an optimal path size is then a "best guess" approach. When the databsaes are first built, the program will scan the base file and tell you the minimum size possible. You can then use the up and down arrow keys to adjust this. We suggest increasing the minimum path size found by ten or twenty characters. If, in the future, a path is created that is larger than that defined in the database, you will have to go through the "Delete old records" option from the main menu to adjust this size, and then re-apply the base file to history. PAGE 6 -- DELETING OLD RECORDS -- After some point in time the history file contains many records and may be very large in space. This option will remove old records that were logged prior to a date you specify. The process also performs a reorganization of the database at the same time. You are prompted for a date before which all history records will be deleted. History records that have comments will not be deleted unless you reply 'yes' to prompt indicating this. A history record that is older than the date supplied will not be deleted if it is the only record for that file. At least one record of the file is needed so future applications of the base file can accurately record any changes. If the last record for a file were deleted, the application of the base file would not know if the file has changed, it would automatically be logged as an add. If you don't want to delete any records but feel that a reorganization is needed, supply a delete date of 00/00/0000. Since no records can exist with a date prior to 00/00/0000, no records will be deleted, but a reorganization will still be performed. After the delete and reorganization are performed, a re-index is automatically performed. The disk space database is excluded from this deletion process. The space used by this database is small, and the more samples available for the graphing feature the better. All fields on the Delete Old Records screen have help text available. The user simply moves the cursor to the field in question and presses the [F1] key. The option exists in this process to change the size of the path name as defined in the database. This is needed when a new base file is applied to history and a new path name is encountered that is larger than that defined in the database. You can press F8 which will scan both the current base file and the database to find the minimum size the path can be defined as. You can also adjust this size by using the up and down arrow keys. Keeping this size to the minimum will result in faster response time and will aslo use less disk space, but will probably be too small in the near future. PAGE 7 -- RE-INDEXING THE DATABASES -- The databases use standard B-TREE index processing and are thus always up to date. If a program is abnormally terminated the indexes may not be properly closed and/or updated which will require a re-index. This condition is detected by all programs and will display an error message indicating that the indexes are corrupted. This option will perform the required re-index. The B-TREE processing locks the indexes whenever the databases are in use. If you try to use the databases in a multi-tasking environment, the first user will lock the databases, and the second user will get an index corrupted message. In this case the index is not corrupted, but simply in use. PAGE 8 -- BROWSE AND SEARCH FILES -- This option will allow the user to browse all files contained in history. The screen is initially displayed with selection criteria of all files, all paths, all dates, and all additions, changes, and deletions. The current selection criteria is displayed on lines 2 and 3 of the display. The last line of the screen shows the special function keys. The main body of the screen shows the files that meet the selection criteria. The fields in the main body of the screen are defined below: File - File Name. In column 1 thru 3 before file name you will see spaces if the file was logged as a new or added file, 'Chg' if the file was logged as a change, or 'Del' if the file was logged as a delete. Also, if an asterisk (*) appears immediately before the file name, a comment exists for this file. Ext - File Extension. Date - The date the file was created or modified. Time - The time the file was created or modified. Size - The size of the file. CRC1 - The first cyclic redundancy check. CRC2 - The second cyclic redundancy check. Log Date/ - The date and time of THE DETECTIVE run that Time logged the file. Path - The drive and directory the file resides in. Only the first few bytes of this path name are displayed, pressing the left and/or right arrow keys will toggle between path and CRC1/CRC2/Log date and time/Short path name. PAGE 9 -- BROWSE AND SEARCH FILES (con't) -- The special keys displayed on the last line of the screen perform the following: F1 - Opens the context sensitive help menu. F2 - Opens a window containing the comments for the file currently highlighted by the selection bar. If no comments exist, you have the option of adding comments. If comments do exist, the are displayed and you can either change or delete them. When the comment window is displayed, you can delete the comment by pressing F5, update/add the comment by pressing F10, or do nothing and return to browsing by pressing ESC. F3 - Opens a window allowing you to change the selection criteria. The fields that you can limit the search of history to are as follows: File - Specifies the file name to search for. The wildcards * and ? are available. *.COM will display all .COM files, *.* will display all files. Path - Specifies the path to search for files. Again, Wildcards are available. * will show all files, C* will show all files in drive C, D:\ will show all files in the root directory of drive D From - Shows all files that were logged on or after this date. To - Shows all files that were logged on or before this date. A/C/D/* - Shows either (A)dded files, (C)hanged files, (D)eleted files, or (*)All files. Sequence - Displays files in either (F)ile or (P)ath sequence. ESC - Return you to the main menu. Page up - Displays the previous page Page down - Displays the next page. Home - Displays the first page. End - Displays the last page. Up arrow - Moves the selection bar up one line. Down arrow - Moves the selection bar down one line. Left arrow - Toggles between full and short path name. Right arrow - Toggles between full and short path name. PAGE 10 -- GRAPHICALLY DISPLAY DISK SPACE -- This option allows the user to graphically display the disk space used by files in the history. This option requires a graphics adapter and will issue a message if one does not exist. Also, at least 5 samples of space usage are required before a graph can be displayed. This means that you have to have run the application of the base file to history at least 5 times. The following fields must be supplied before a graph can be displayed: From - Beginning date for samples selected. To - Ending date for samples selected. Drive - Which drive to graph disk space for. Skip - Number of samples to skip between samples selected. You may never need to specify a value other than zero. The program determines how many lines can be plotted based on the maximum resolution of your graphics card. For a standard EGA resolution of 640 x 350, 580 lines can be drawn. If the number of samples is greater than 580, you can either skip 1 sample between samples taken, or change the from and to dates to reduce the number selected. Help is available for all fields by moving the cursor to the desired field and pressing the [F1] key. If too many or not enough samples are selected, a message is displayed showing the samples taken. You then have the option of changing the options or pressing escape and returning to the main menu. PAGE 11 -- PRINT FILES AND COMMENTS -- This option will allow the user to print any or all files contained in history. The screen is displayed at which point the user has to enter the criteria for files selected for printing. The individual selection and control fields are defined below: File - Specifies the file name to search for. The wildcards * and ? are available. *.COM will print all .COM files, *.* will print all files. Path - Specifies the path to search for files. Again, Wildcards are available. * will show all files, C* will show all files in drive C, D:\ will show all files in the root directory of drive D. From - Prints all files that were logged on or after this date. To - Prints all files that were logged on or before this date. A/C/D/* - Prints either (A)dded files, (C)hanged files, (D)eleted files, or (*)All files. Sequence - Prints files in either (F)ile or (P)ath sequence. Include - If 'Y' specified, Comments for each file will be printed (if any exist), 'N' will not print comments. Notes: - You can enter up to 2 lines of text that will be printed on the first page of the report. Lines per - Specify the number of lines per page, generally 66 is fine (6 lines per inch print on 11 inch paper). The program simply prints to the first printer port, it does not send any printer control codes. If you want to do some special type of printing, set the printer before starting to print. The first page of the report contains all criteria entered, the actual files and comments (if selected) starts on page 2. The note field may be useful by indicating why you ran the report or maybe who the report should go to. The report will fit on 8.5 x 11 inch paper as long as you set the printer for compressed print. PAGE 12 -- MAINTAIN AND BROWSE FILE COMMENTS -- This option will allow the user to browse and maintain comments in history. The screen is initially displayed with selection criteria of all files, all paths and all dates. The current selection criteria is displayed on lines 2 and 3 of the display. The last line of the screen shows the special function keys. The main body of the screen shows the files that meet the selection criteria. The fields in the main body of the screen are defined below: File - File Name. In column 1 thru 3 before file name you will see spaces if the file was logged as a new or added file, 'Chg' if the file was logged as a change, or 'Del' if the file was logged as a delete. Log Date/ - The date and time of THE DETECTIVE run that Time logged the file. Path - The drive and directory the file resides in. Comment - The actual comment lines. Pressing the left and Lines right arrow keys will toggle between comment lines 1 through 10 and the file path. PAGE 13 -- MAINTAIN AND BROWSE FILE COMMENTS (con't)-- The special keys displayed on the last line of the screen perform the following: F1 - Opens the context sensitive help menu. F3 - Opens a window allowing you to change the selection criteria. The fields that you can limit the search of history to are as follows: File - Specifies the file name to search for. The wildcards * and ? are available. *.COM will display all .COM files, *.* will display all files. Path - Specifies the path to search for files. Again, Wildcards are available. * will show all files, C* will show all files in drive C, D:\ will show all files in the root directory of drive D. From - Shows all files that were logged on or after this date. To - Shows all files that were logged on or before this date. F8 - Pressing F8 while in this options window will execute the file browse program. This allows you to temporarily browse files and add/change/delete comments. When you exit this program, you will return to the comment maintenance screen. F5 - Deletes the comments for the file that the selection bar is under ESC - Return you to the main menu. Page up - Displays the previous page Page down - Displays the next page. Home - Displays the first page. End - Displays the last page. Up arrow - Moves the selection bar up one line. Down arrow - Moves the selection bar down one line. Left arrow - Toggles between full and short path name. Right arrow - Toggles between full and short path name. Enter - The enter key allows you to modify or delete the comments for the file the selection bar is under. A detail screen is then displayed showing all 10 comment lines. You can change comments and press F10 to update them or press F5 to delete them. Page up, down, home, and also function so you can browse comments in detail. PAGE 14 -- MISCELLANEOUS -- COMMAND LINE PARAMETERS: When you type DLMENU and press enter, the system by default picks the first base file for you. You can however, invoke the menu and pass a base file for it to use. For example, if you had a MYSYS.NEW and a SPECIAL.NEW, you could invoke the menu by typing 'DLMENU SPECIAL.NEW' and pressing enter. This would force processing to use the SPECIAL.NEW file. This also works on all programs in the logging system, you don't have to go through the menu if you don't want to. COMBINING THE DETECTIVE AND THE DETECTIVE LOG: You can setup a batch file to automatically run the apply base file to history after the checkout process from THE DETECTIVE. Suppose you have a control file named MYSYS.CTL. The following batch file would automatically update history after THE DETECTIVE runs: DETECT MYSYS C DLLOAD MYSYS.NEW FILES CREATED BY THE DETECTIVE LOG: The following files are created for each base file loaded to history: [ctrlfile].D01 - File database [ctrlfile].D02 - Comment database [ctrlfile].D03 - Disk space usage database [ctrlfile].X11 - Index on file database by path [ctrlfile].X12 - Index on file database by file [ctrlfile].X21 - Index on comment database [ctrlfile].X31 - Index on disk space database APPENDIX A -- SYSTEM REQUIREMENTS, LIMITS AND PERFORMANCE -- THE DETECTIVE has been successfully run using DOS 2.0 through DOS 4.0 and has been run on the following machines (not all versions of DOS on all machines): o IBM PC o IBM XT o IBM XT/286 o IBM AT o IBM PS/2 Model 50, 60, 70 and 80 o Compac Deskpro o Compac SLT 286 o Leading Edge Model D o Panasonic Business Partner o Gateway 2000 25mhz 80386 THE DETECTIVE LOG has a color display while running and works well using Monochrome, CGA, EGA, and VGA adapters/monitors. A graphics card is required for graph function. THE DETECTIVE LOG requires 400k THE DETECTIVE LOG is written totally in Turbo C. The performance of our B-TREE indexed file manager has been improved in version 3.1 over previous versions. We will continue to improve performance and provide free updates when performance is up to the level we would like. The size of the databases created is limited only by the amount of free disk space available on your machine. If you use the system rarely, we suggest you compress it with one of the many file compression packages available. The size of databases and indexes is large mainly due to the size of the DOS path. You have control over the size of this path, but keep in mind that the larger the path, the longer the response time and more disk space will be used. APPENDIX B -- WARRANTY/DISCLAIMER/TERMS & CONDITIONS -- PC Soft-Tech warrants to the original purchaser of this computer software product that the recording media on which the programs are recorded will be free from defects in material and workmanship for ninety (90) days from the date of purchase. Defective media returned by the purchaser within ninety (90) days will be replaced without charge provided the returned media have not been subjected to misuse, damage, or excessive wear. PC Soft-Tech does NOT warrant that the programs will meet the purchaser's specific requirements. ANY STATEMENTS MADE REGARDING THE UTILITY OF THE PROGRAMS ARE NOT TO BE CONSTRUED AS EXPRESS OR IMPLIED WARRANTIES. THIS WARRANTY IS IN LIEU OF ALL OTHER WARRANTIES, WHETHER WRITTEN OR ORAL, EXPRESSED OR IMPLIED. ANY IMPLIED WARRANTIES, INCLUDING IMPLIED WARRANTIES OF MECHANTABILITY AND FITNESS FOR A SPECIFIC PURPOSE ARE EXCLUDED. IN NO EVENT WILL PC SOFT-TECH BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH THE SOFTWARE PRODUCT. Registered copies of THE DETECTIVE LOG may be purchased by completing the attached registration form and send it with a check for $45.00 per copy (quantity discounts, network pricing, and site licenses also available) to PC Soft-Tech at the address given. Purchase orders will be accepted subject at all times to approval of PC Soft-Tech. Terms of payment for orders received via purchase order are due net 30 days. PC Soft-Tech shall not be liable for delays in performance caused by riots, strikes, floods, accidents, or any other contingency beyond its control. Accepted orders are subject to cancellation charges to the extent PC Soft-Tech shall be reimbursed for the cost of reasonable expense incurred prior to the cancellation as a result of order acceptance. THE DETECTIVE LOG distribution package, consisting of the program and documentation files are copyright (c) 1990 by PC SOFT-TECH. The author reserves the exclusive right to distribute this product, or any part thereof, for profit. Under NO CIRCUMSTANCES may modified versions or disassembled versions be distributed, either for profit or in the public domain. APPENDIX B -- WARRANTY/DISCLAIMER/TERMS & CONDITIONS (con't)-- User's groups, clubs, libraries and clearing houses are authorized to distribute the FREE version of THE DETECTIVE LOG pursuant to the following conditions: 1. No charge is made for the software or documentation. A nominal distribution fee may be charged, provided that it is no more that $7 total. 2. The program and documentation are distributed together and are not modified in ANY way. APPENDIX C -- REGISTRATION -- Once you become a registered user of THE DETECTIVE and/or THE DETECTIVE LOG, you will receive a new version of THE DETECTIVE and/or THE DETECTIVE LOG which will include root directory files in the tracking process. You will also receive the following benefits: o Support by phone, mail, or through our bulletin board system. Support will only be provided to registered users. o Notice of significant upgrades and bug fixes. You will be notified by mail for any such updates. There will be no charge for updates as long as you send us a diskette and return postage. You can also receive a free update through our private bulletin board. Each copy of THE DETECTIVE and THE DETECTIVE LOG is registered for use on one computer only and a registered copy is required for each additional computer. The price breakdown is given below: THE DETECTIVE plus THE DETECTIVE THE DETECTIVE LOG Copies Price Per Copy Price Per Copy -------- ---------------- ------------------- 1-50 $25.00 $45.00 51-100 $21.00 $40.00 101-500 $18.00 $35.00 500+ $16.00 $30.00 The price for networks $50.00 for each file server and $5.00 for each computer (node) on the network (THE DETECTIVE). The price for networks $75.00 for each file server and $10.00 for each computer (node) on the network (THE DETECTIVE and THE DETECTIVE LOG). The registered version of THE DETECTIVE can be used in commercial, educational, and governmental institutions. The free version of THE DETECTIVE is expressly prohibited for use in commercial, educational, and governmental institutions except for the purpose of evaluation. APPENDIX C -- REGISTRATION FORM -- Please send me a copy of the current full version of THE DETECTIVE and/or THE DETECTIVE LOG and add me to the list of registered users, to be eligible for support and update notices. Computer Model: _____________________________________________ -----Quantity by diskette type----- THE DETECTIVE _______ 5.25 in. ________ 3.5 in. THE DETECTIVE and THE DETECTIVE LOG _______ 5.25 in. ________ 3.5 in. May we send you high-density diskettes? _____(yes) _____(no) Company Name: _____________________________________________ Your Name: _____________________________________________ Title: _____________________________________________ Address: _____________________________________________ City, State, Zip: _________________________________________ Phone: _____________________________________________ Any initial comments about THE DETECTIVE products? ___________________________________________________________ ___________________________________________________________ ___________________________________________________________ Where did you hear about THE DETECTIVE product? ___________________________________________________________ ___________________________________________________________ ___________________________________________________________ May we use your comments and/or name in future literature for THE DETECTIVE products? _____(yes) _____(no) Send registration form and check or money order to: PC SOFT-TECH P.O. Box 742 Mequon, Wi. 53092 (414) 241-9119 - Voice (414) 241-9125 - BBS (9600,N,8,1)